﻿// --------------------------------------------------------------------------------------------------------------------
// <copyright file="MacroParametersAttribute.cs" company="CodePlex">
//   The MIT License
//   Copyright (c) 2013 Julien Blin
//   
//   Permission is hereby granted, free of charge, to any person obtaining a copy
//   of this software and associated documentation files (the "Software"), to deal
//   in the Software without restriction, including without limitation the rights
//   to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
//   copies of the Software, and to permit persons to whom the Software is
//   furnished to do so, subject to the following conditions:
//   
//   The above copyright notice and this permission notice shall be included in
//   all copies or substantial portions of the Software.
//   
//   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
//   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
//   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
//   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
//   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
//   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
//   THE SOFTWARE.
// </copyright>
// --------------------------------------------------------------------------------------------------------------------

namespace UCodeFirst.Macros
{
    using System;
    using System.Diagnostics.CodeAnalysis;

    /// <summary>
    /// Allows the definition of macro properties, such as the name or the cache.
    /// </summary>
    [AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = true)]
    public class MacroParametersAttribute : NameAttributeBase
    {
        /// <summary>
        /// Initializes a new instance of the <see cref="MacroParametersAttribute"/> class.
        /// </summary>
        public MacroParametersAttribute()
        {
            this.UseInEditor = DefaultValues.UseInEditor;
            this.RenderContent = DefaultValues.RenderContent;
            this.CachePeriod = DefaultValues.CachePeriod;
            this.CacheByPage = DefaultValues.CacheByPage;
        }

        /// <summary>
        /// Gets or sets a value indicating whether to use this macro in the editor.
        /// </summary>
        public bool UseInEditor { get; set; }

        /// <summary>
        /// Gets or sets a value indicating whether to render this macro in the editor.
        /// </summary>
        public bool RenderContent { get; set; }

        /// <summary>
        /// Gets or sets a value indicating the period for the cache.
        /// </summary>
        public int CachePeriod { get; set; }

        /// <summary>
        /// Gets or sets a value indicating whether to cache this macro by page.
        /// </summary>
        public bool CacheByPage { get; set; }

        /// <summary>
        /// Holds default values.
        /// </summary>
        public static class DefaultValues
        {
            /// <summary>
            /// false
            /// </summary>
            [SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1630:DocumentationTextMustContainWhitespace", Justification = "Reviewed. Suppression is OK here.")]
            public const bool UseInEditor = false;

            /// <summary>
            /// true
            /// </summary>
            [SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1630:DocumentationTextMustContainWhitespace", Justification = "Reviewed. Suppression is OK here.")]
            public const bool RenderContent = true;

            /// <summary>
            /// 0
            /// </summary>
            [SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1631:DocumentationMustMeetCharacterPercentage", Justification = "Reviewed. Suppression is OK here.")]
            [SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1630:DocumentationTextMustContainWhitespace", Justification = "Reviewed. Suppression is OK here.")]
            public const int CachePeriod = 0;

            /// <summary>
            /// true
            /// </summary>
            [SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1630:DocumentationTextMustContainWhitespace", Justification = "Reviewed. Suppression is OK here.")]
            public const bool CacheByPage = true;
        }
    }
}
